Package com.cisco.pt.ipc.sim
Interface EnvironmentKeyframe
- All Superinterfaces:
IPCObject
- All Known Implementing Classes:
EnvironmentKeyframeImpl
Information provided by the PKI file:
\class EnvironmentKeyframe
\brief An object in the Physical Workspace.
- Author:
- Auto-generated
-
Method Summary
Modifier and TypeMethodDescriptiongetEnvironment(String env) Information provided by the PKI file:Information provided by the PKI file:intInformation provided by the PKI file:intgetTime()Information provided by the PKI file:voidsetTime(int time) Information provided by the PKI file:Methods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Method Details
-
getTime
int getTime()Information provided by the PKI file:
\brief Returns the time the keyframe is set to exist at, in seconds. \return int, value is the time the keyframe resides at, in seconds.- Returns:
- int Returns a int
-
setTime
void setTime(int time) Information provided by the PKI file:
\brief Sets the time the keyframe exists at, in seconds. \param time, value is the time the keyframe resides at, in seconds.- Parameters:
time- Takes in a parameter of time
-
getEnvironmentOptionsCount
int getEnvironmentOptionsCount()Information provided by the PKI file:
\brief Returns how many different environment value properties ("CO", "Sunlight", etc) are in the key frame. \return int, value is how many different environment value properties ("CO", "Sunlight", etc) are in the key frame.- Returns:
- int Returns a int
-
getEnvironmentKeys
Information provided by the PKI file:
\brief Returns the names of all the environment value properties ("CO", "Sunlight", etc) are in the key frame. \return vector<QString>, a list with an entry for each environment property name in the keyframe.- Returns:
- List<String> Returns a List<String>
-
getEnvironment
Information provided by the PKI file:
\brief Returns the environment properties for the environment value property type passed. \param env, Name of the environment property type to get the properties for. Like "CO", "Sunlight", etc. \return EnvironmentOptions, the enivronment options for the given environment value type.- Parameters:
env- Takes in a parameter of env- Returns:
- EnvironmentOptions Returns a EnvironmentOptions
-